Update documentation for cookie handling commands
authorSjoerd Simons <sjoerd@luon.net>
Mon, 17 Oct 2016 20:47:58 +0000 (22:47 +0200)
committerAtomic Bot <atomic-devel@projectatomic.io>
Sat, 5 Nov 2016 17:34:09 +0000 (17:34 +0000)
Closes: #531
Approved by: cgwalters

man/ostree-remote.xml
man/ostree.repo-config.xml

index 2e6008454a5ee530b63cecee148e303827561272..88e61ac0f04f8d6153ebcf041341f70f3270a01c 100644 (file)
@@ -69,6 +69,25 @@ Boston, MA 02111-1307, USA.
             <cmdsynopsis>
                 <command>ostree remote summary</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">NAME</arg>
             </cmdsynopsis>
+            <cmdsynopsis>
+                <command>ostree remote add-cookie</command>
+                <arg choice="req">NAME</arg>
+                <arg choice="req">DOMAIN</arg>
+                <arg choice="req">PATH</arg>
+                <arg choice="req">COOKIE_NAME</arg>
+                <arg choice="req">VALUE</arg>
+            </cmdsynopsis>
+            <cmdsynopsis>
+                <command>ostree remote delete-cookie</command>
+                <arg choice="req">NAME</arg>
+                <arg choice="req">DOMAIN</arg>
+                <arg choice="req">PATH</arg>
+                <arg choice="req">COOKIE_NAME</arg>
+                <arg choice="req">VALUE</arg>
+            </cmdsynopsis>
+            <cmdsynopsis>
+                <command>ostree remote list-cookies</command> <arg choice="req">NAME</arg>
+            </cmdsynopsis>
     </refsynopsisdiv>
 
     <refsect1>
@@ -83,6 +102,9 @@ Boston, MA 02111-1307, USA.
         <para>
             The GPG keys to import may be in binary OpenPGP format or ASCII armored.  The optional <arg>KEY-ID</arg> list can restrict which keys are imported from a keyring file or input stream.  All keys are imported if this list is omitted.  If neither <option>--keyring</option> nor <option>--stdin</option> options are given, then keys are imported from the user's personal GPG keyring.
         </para>
+        <para>
+            The various cookie related command allow management of a remote specific cookie jar.
+        </para>
     </refsect1>
 
     <refsect1>
index 0c421ba46c6dcd21e279616c36a124b3998f2576..1182aa93e9e3a61196a1125af6183a1a61cfb498 100644 (file)
@@ -204,6 +204,18 @@ Boston, MA 02111-1307, USA.
       in the section <literal>GPG verification</literal>.
     </para>
   </refsect1>
+
+  <refsect1>
+    <title>Per-remote HTTP cookies</title>
+    <para>
+      Some content providers may want to control access to remote
+      repositories via HTTP cookies.  The <command>ostree remote
+      add-cookie</command> and <command>ostree remote
+      delete-cookie</command> commands will update a per-remote
+      lookaside cookie jar, named
+      <filename>$remotename.cookies.txt</filename>.
+    </para>
+  </refsect1>
   
   <refsect1>
     <title>See Also</title>